﻿//-----------------------------------------------------------------------
// <copyright file="ILogManager.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace TileTool.Log
{
    /// <summary>
    /// Log manager interface.
    /// </summary>
    public interface ILogManager
    {
        /// <summary>
        /// Event triggered when there is a new log.
        /// </summary>
        event LogEventHandler NewLog;

        /// <summary>
        /// Add the passed target to the set of targets log messages
        /// are output to.
        /// </summary>
        /// <param name="target">Target to add to the manager.</param>
        void AddOutputTarget(ILogOutputTarget target);

        /// <summary>
        /// Remove the passed target from the set of output targets.
        /// </summary>
        /// <param name="target">Target to remove from the manager.</param>
        void RemoveOutputTarget(ILogOutputTarget target);

        /// <summary>
        /// Log a formatted string at the passed log level.
        /// 
        /// There is no need to add a new line to log statements since each
        /// log will have a newline added to it.
        /// </summary>
        /// <param name="level">Log level for the message.</param>
        /// <param name="group">Group this log message is associated with.</param>
        /// <param name="format">Message format.</param>
        /// <param name="args">Message args.</param>
        void Log(LogLevel level, string group, string format, params object[] args);
    }
}
